M

Document.NewFlexPipe

Description:
Adds a new flexible pipe into the document, using a point array and pipe type.

Overloads (3):

NewFlexPipe

NewFlexPipe(Connector,Connector,FlexPipeType)

NewFlexPipe(Connector,IList[XYZ],FlexPipeType)

NewFlexPipe(IList[XYZ],FlexPipeType)

public FlexPipe NewFlexPipe(
	IList<XYZ> points,
	FlexPipeType pipeType
)

Public Function NewFlexPipe ( 
	points As IList(Of XYZ),
	pipeType As FlexPipeType
) As FlexPipe

public:
FlexPipe^ NewFlexPipe(
	IList<XYZ^>^ points, 
	FlexPipeType^ pipeType
)

member NewFlexPipe : 
        points : IList<XYZ> * 
        pipeType : FlexPipeType -> FlexPipe

IList<XYZ>

points

The point array indicating the path of the flexible pipe, including the end points.
FlexPipeType

pipeType

The type of the flexible pipe.

Return Value FlexPipe If creation was successful then a new flexible pipe is returned, otherwise an exception with failure information will be thrown.

ArgumentNullException

Thrown when the input argument points is.
InvalidOperationException

Thrown when the flexible pipe cannot be created or regenerate fails.
ArgumentException

Thrown if the flexible pipe type does not exist in the given document.